home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / os2 / tton1770.zip / templeton.cfg < prev    next >
Text File  |  1996-10-20  |  14KB  |  316 lines
  1. # *************************************************************
  2. #  Templeton, copyright 1995, 1996 N.A. Krawetz
  3. #  All rights reserved.
  4. # *************************************************************
  5.  
  6. # configuration for Templeton
  7. #
  8. # Lines beginning with a '#' are comments and are ignored.
  9. # Lines should not be more than 80 characters.
  10. # Operands in this file are in the form:
  11. #    parameter value
  12. # The parameter is case insensitive, except where a text string or URL
  13. # is required.
  14. # Boolean values ("true" or "false") are case insensitive.
  15. # Numeric values should be numbers -- non-numbers are regarded as 0.
  16. # All other types of values ARE case sensitive.
  17.  
  18.  
  19. # ******************** Registration ****************************
  20. # Register: registration code
  21. # Software that is registered contains a unique registration
  22. # code.  This code should be entered exactly as it is provided.
  23. # If your site contains multiple registrations, you may list
  24. # each registration code on a line starting with the
  25. # key word "Register".
  26. # Please read the licensing agreement for registration
  27. # information.
  28. #   Register 12-34567-891011
  29.  
  30.  
  31. # ******************* File System *****************************
  32. # LocalPath: absolute path
  33. # LocalPath informs the program where to store the downloaded files.
  34. # IF this path is:
  35. #   LocalPath none
  36. # THEN no files are generated.  Only a log file containing the remote
  37. # servers WWW map is created in the current directory.
  38. #
  39. # Currently, files should be stored in the root directory of the file system.
  40. # For WWW servers, this is the server's root directory.
  41. # (This limitation will be removed in future releases.)
  42. # For DOS based machines, this path may include a drive letter:
  43. #   LocalPath e:\server.www\
  44. #
  45. # Either slash "/" or backslash "\" are valid for specifying a directory.
  46. # The trailing slash or backslash is optional.
  47. #
  48. # This option is only used when the "Interactive" option is FALSE.
  49. LocalPath /
  50.  
  51. # User: e-mail address
  52. # In case of emergency, this is the person who is running the program
  53. # and who should be contacted to stop the program from running.
  54. # This MUST be a valid e-mail address, and SHOULD also be available with
  55. # a "talk" command.
  56. # As a side note, it is never a good idea to let automatic software run
  57. # unsupervised (especially this type of software).  The "User" should be
  58. # available to read their e-mail at all times during the execution of this
  59. # program.
  60. # The default is the account running the program on the current machine.
  61. #  User webmaster@host.machine.org
  62.  
  63.  
  64. # ********************* Restrictions *****************************
  65.  
  66. # RestrictHost: boolean
  67. # This parameter informs the program not to leave the designated host.  Links
  68. # to machines not on the current host are not traversed.
  69. RestrictHost TRUE
  70.  
  71. # RestrictPath: absolute path
  72. # This parameter is only used when a host is restricted.
  73. # When a host is restricted, a subpath on that host may also be restricted.
  74. # Hypertext references to documents outside this subtree are not traversed.
  75. # Either slash "/" or backslash "\" are valid for specifying a directory.
  76. # The trailing slash or backslash is optional.
  77. RestrictPath /
  78.  
  79. # RestrictDepth: numeric value
  80. # Hyperlinks are travered in a breadth-first search.  An unrestricted search
  81. # may download an entire WWW server's data.  By restricting the depth,
  82. # only immediate portions of the server will be received.
  83. # Images and non-href links are considered to be at the same depth as the
  84. # document.
  85. # A restricted depth of 0 means no restriction.
  86. # The default is 1
  87. RestrictDepth 1
  88.  
  89. # RemoveRestricted: boolean
  90. # This parameter informs the program to remove untraversed links.  Links to
  91. # restricted machines or restricted depths are removed from the HTML file,
  92. # but the visible test is still available (just not a hyperlink).
  93. # The default value is FALSE.
  94. RemoveRestricted FALSE
  95.  
  96. # Add: URL
  97. # Place a specific URL on the list of URLs to process.
  98. # Be aware that restrictions apply.
  99.  
  100. # Exclusion: boolean
  101. # This parameter determines whether Templeton will support server provided
  102. # robot exclusion files (robots.txt).  Many servers maintain exclusion files
  103. # to prevent robots from wandering around virtual directory trees, from
  104. # retrieving very temporary or uncomplete files, or copyright materials.  It
  105. # is considered "polite" for web agents to obey the exclusion files when they
  106. # exist.  The default value, TRUE, means that robot exclusion files are obeyed.
  107. # Setting Exclusion to FALSE will ignore robot exclusion files.
  108. Exclusion TRUE
  109.  
  110. # Deny: URL
  111. # The URL provided, as well as all subtrees or the URL, are not processed.
  112. # Many times specific directory subtrees are not desirable.  You can deny
  113. # retrieval of these URL's using this setting.
  114. # For example, to NOT retrieve the "archive" subtree of the host loco.com,
  115. # you would specify:
  116. #   Deny http://loco.com/archive/
  117. # If you do not include the trailing slash (http://loco.com/archive) then
  118. # all subdirectories beginning with "archive" are not processed.  This
  119. # includes "archive.1", "archive.old", "archive_from_1994", etc.
  120. # Multiple Deny statements may be specified.
  121.  
  122. # Allow: URL
  123. # Similar to "Deny", "Allow" explicitly specifies that a subtree is
  124. # retrievable.  When used in conjunction with Deny URL, branches of a
  125. # subtree may be specified for access, while other subtrees are ignored.
  126. # Multiple Allow statements may be specified.
  127.  
  128. # Sleep: numeric
  129. # Sleep determines the number of seconds to pause before sending a request to
  130. # a WWW server.  SLEEP IS IMPORTANT.
  131. # Warning: Templeton can generate thousands of requests per minute.  Many 
  132. # WWW servers cannot handle a sudden onslaught of requests.  Setting the
  133. # Sleep parameter to 0 (zero) may generate too many requests for the server
  134. # and kill the server.  This is bad.
  135. # A sleep setting of 0 (zero) is known to kill the following types of servers:
  136. #   All WWW servers that run under Microsoft Windows (TM)
  137. #   Old generation (HTML/1.0) CERN servers on all platforms
  138. # Low sleep values may also generate large amounts of network traffic and
  139. # hog network resources.
  140. # For safety, you should set the sleep interval to at least 5 seconds.
  141. # The longer, the better.  Remember, this program is automated and can
  142. # easily run for hours.  What's the rush?
  143. Sleep 10
  144.  
  145.  
  146. # ********************* Network *****************************
  147.  
  148. # ProxyHost: hostname or IP address
  149. # Proxy agents are machines that act as a gateway through a firewall.
  150. # If your local network uses a proxy agent, specify the name of
  151. # the proxy agent here.  If you are uncertain about your network, consult your
  152. # network manager or provider.
  153. # A proxy server is only used when a server is specified.
  154. #  ProxyHost    proxyhost.network.net
  155.  
  156. # ProxyPort: integer
  157. # When using a proxy server (see ProxyHost), the port on the proxy server
  158. # should be specified.  The default port is 80.  This values is not
  159. # used if no proxy host is specified with ProxyHost.
  160. ProxyPort    80
  161.  
  162. # Spoof: text-string
  163. # Some WWW servers make incorrect assumptions about the browser/robots.  (Most
  164. # of these are the Netscape servers.)  These servers assume that, since the
  165. # browser is not "Netscape" the browser cannot handle the HTML documents and
  166. # therefore, the document is not transfered.  By "spoofing" a different name,
  167. # the WWW robot can use a qualified browser name to retrieve the HTML
  168. # document.  
  169. # NOTE: The first word of the spoof-name is used for restrictions when 
  170. # robot exclusion is honored (see Exclusion).  This means, if Templeton tells
  171. # the WWW server that it is "Netscape" and the server does not permit
  172. # Netscape browsers, then the server will also not permit Templeton.
  173. # Common spoof names (and browsers) are:
  174. #   Mozilla    Netscape Browser
  175. #   WebCrawler    WebCrawler robot
  176. #   InfoSeek    InfoSeek robot
  177. #   WebExplorer IBM WebExplorer for OS/2
  178. #   Harvest    a web robot
  179. #   Mosaic    NCSA Mosaic
  180. #   Lynx    Lynx, text browser
  181. #   Microsoft Internet Explorer
  182. #   PRODIGY-WB    Prodigy browser
  183. # Spoof Mozilla (Templeton)
  184.  
  185.  
  186. # ********************* Preferences *****************************
  187.  
  188. # FATFormat: boolean
  189. # Determines the file name format for the current operating system.
  190. # DOS based machines using drives formatted with a File Allocation Table (FAT)
  191. # can only handle file names containing 8 characters and a 3 character
  192. # extension.  Setting this option to TRUE will generate 8.3 character file
  193. # names.  The default is FALSE, and will generate unlimited length file names.
  194. # NOTE: Under DOS, this option is always TRUE (DOS only supports FAT file
  195. # names).  Under OS/2, this value becomes TRUE automatically if the destination
  196. # path (LocalPath) is located on a FAT partition.
  197. FATFormat FALSE
  198.  
  199. # FileOverwrite: boolean
  200. # Files that already exist on the local system are not normally downloaded.
  201. # Setting the FileOverwrite option to TRUE will overwrite files on the
  202. # local file system.  Default value is FALSE.
  203. FileOverwrite TRUE
  204.  
  205. # Index: file name
  206. # For hypertext references that only specify a directory, this is the
  207. # default html file in the directory.
  208. # NOTE: if FATFormat is TRUE, the 8.3 name translation will be applied to
  209. # this file name.
  210. # The default name is "index.html"
  211. Index index.html
  212.  
  213. # ISMAP: absolute path to executable
  214. # For WWW servers, many imagemaps use a program that takes coordinates from
  215. # a selected image <IMG SRC=... ISMAP> and return a new URL.  Some of the
  216. # more common methods use a data file containing known coordinates and a
  217. # program to identify which URL is activated.  Commonly, this program is
  218. # called "imagemap" or "imagemap.exe".
  219. # The ISMAP parameter specifies the WWW server's path to the imagemap program.
  220. ISMAP /cgi-bin/imagemap
  221.  
  222. # MapType: NCSA or CERN
  223. # For the executable specified in the ISMAP parameter (see above), this
  224. # option determines the format of the file.  If the image map file can be
  225. # retrieved, then it is converted into this specified format.
  226. # Valid options are either "CERN" or "NCSA".  The default is NCSA.
  227. MapType NCSA
  228.  
  229.  
  230. # ********************* Logging *****************************
  231. # Mailto-File: file name
  232. # Similar to "Server-File" logging, the file name listed on the "Mailto-File"
  233. # line contains a list of e-mail addresses found in the HTML documents.  Only
  234. # e-mail addresses that are active (hyperlinks) are used.  E-mail addresses
  235. # displayed as plain text in the document or contained in CGI scripts are not
  236. # listed in the mailto logfile.
  237. # NOTE:  This list MAY contain duplicate entries.  Duplication removal may be
  238. # added in later versions.
  239. # (Some people have found this to be a very useful feature for generating
  240. # mailing lists.)
  241. # The default is no mailto logging.
  242. # Mailto-File mailtolist
  243.  
  244. # RemoteMapping: boolean
  245. # Determines whether remote mapping will be done.  The default is TRUE
  246. # while does perform mapping.  The map file name is mapindex.html and is
  247. # either located at the root of the LocalPath or in the current directory
  248. # if the system is not mirroring files.
  249. # Note: if you change the default index name, for example, to "welcome.html"
  250. # then the default map file will be "mapwelcome.html".
  251. RemoteMapping TRUE
  252.  
  253. # Server-File: file name
  254. # A data file is generated containing the host name, IP address, and
  255. # WWW server type for each server visited.  For servers listed as IP
  256. # address only, the host name is also the IP address.
  257. # The default is no server logging.
  258. # Server-File serverlist
  259.  
  260.  
  261. # ********************* Advanced *****************************
  262. # The advanced configuration commands should be used with caution.
  263. # These commands allow other applications to perform tasks on the
  264. # retrieved documents.  Applications that are spawned (operate
  265. # concurrently) with Templeton may overwhelm the user or operating system.
  266. # Spawned applicatons include those begun with "start" under OS/2,
  267. # or followed by "&" under Unix.
  268. # NOTE: Templeton has the capability to spawn thousands of applications
  269. # in a few seconds.
  270. # On Unix-type systems, Templeton introduces security risks when executed
  271. # as root.
  272. # For applications that are not spawned, Templeton will pause until
  273. # the application has ended.  This allows for a guarenteed order of processing
  274. # for the called applications.
  275.  
  276. # Command_html: string
  277. # Execute a system command on each HTML document stored on the file system.
  278. # This may be useful for counting documents, storing statistics, printing,
  279. # converting, etc.
  280. # The string should contain the executable to run and a %s for the file name.
  281. # The string "none" turns off this command.  This is the default.
  282. # For example: to convert all HTML documents to text using the program
  283. # html2txt (not provided with the Templeton distribution), you would use:
  284. #   Command_html html2txt %s
  285.  
  286. # Command_image: string
  287. # Execute a system command on each image-file stored on the file system.
  288. # Similar to Command_html, Command_image is executed on all image files.
  289. # This may be useful for counting documents, storing statistics, printing,
  290. # converting, etc.  NOTE: no distinction is made between different image
  291. # formats.
  292. # The string should contain the executable to run and a %s for the file name.
  293. # The string "none" turns off this command.  This is the default.
  294.  
  295. # Command_map: string
  296. # Execute a system command on each image-map stored on the file system.
  297. # Similar to Command_html, Command_map is executed on all image-map file.
  298. # This may be useful for counting documents, storing statistics, or converting.
  299. # The string should contain the executable to run and a %s for the file name.
  300. # The string "none" turns off this command.  This is the default.
  301.  
  302. # Command_default: string
  303. # Execute a system command on each file stored on the file system.
  304. # Similar to Command_html, Command_default is executed on all files that have
  305. # no other executable specified.  This may be useful for counting documents,
  306. # storing statistics, printing, converting, etc.
  307. # The string should contain the executable to run and a %s for the file name.
  308. # The string "none" turns off this command.  This is the default.
  309.  
  310. # Interactive: boolean
  311. # Determines whether the user should be prompted for
  312. # configuration information or if Templeton should
  313. # start running automatically.
  314. # The default setting is TRUE.
  315.  
  316.